/*
 * Copyright 2019 Alex Andres
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package dev.onvoid.webrtc.media.video;

import java.nio.ByteBuffer;

public interface I420Buffer extends VideoFrameBuffer {

	/**
	 * Returns a direct ByteBuffer containing Y-plane data. The buffer capacity is
	 * at least getStrideY() * getHeight() bytes. The position of the returned
	 * buffer is ignored and must be 0. Callers may mutate the ByteBuffer (eg.
	 * through relative-read operations), so implementations must return a new
	 * ByteBuffer or slice for each call.
	 */
	ByteBuffer getDataY();

	/**
	 * Returns a direct ByteBuffer containing U-plane data. The buffer capacity is
	 * at least getStrideU() * ((getHeight() + 1) / 2) bytes. The position of the
	 * returned buffer is ignored and must be 0. Callers may mutate the ByteBuffer
	 * (eg. through relative-read operations), so implementations must return a new
	 * ByteBuffer or slice for each call.
	 */
	ByteBuffer getDataU();

	/**
	 * Returns a direct ByteBuffer containing V-plane data. The buffer capacity is
	 * at least getStrideV() * ((getHeight() + 1) / 2) bytes. The position of the
	 * returned buffer is ignored and must be 0. Callers may mutate the ByteBuffer
	 * (eg. through relative-read operations), so implementations must return a new
	 * ByteBuffer or slice for each call.
	 */
	ByteBuffer getDataV();

	int getStrideY();

	int getStrideU();

	int getStrideV();

}
